Delete User
AutomatR.AWS.Activities.DeleteUser
The "Delete User" activity in AutomatR is part of the AWS IAM (Identity and Access Management) activities package, enabling automation processes to delete a specific IAM user. This activity streamlines user management tasks in AWS IAM, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS IAM service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS IAM service. String variables containing the secret access key. |
| Region | Specifies the desired AWS region in which the IAM user will be deleted. Use the RegionEndpoint enumeration to set the region. |
| Name | Specifies the name of the IAM user that you want to delete. String variables containing the IAM user name. |
| Remove All Attached Entities | Enables the removal of all subordinate entities attached to the user, including access keys, policies, login profiles, group memberships, and MFA devices. Boolean variables controlling this behavior. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Delete User" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Delete User" operation, indicating whether the user deletion was successful or encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Delete User" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, IAM user name, and region.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to delete the specified IAM user.
Example: Consider an example where the "Delete User" activity is used to delete an IAM user named "JohnDoe" and remove all attached entities:
Delete User:
Display Name: "Delete IAM User"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
Name: "JohnDoe"
Remove All Attached Entities: true
Result: isDeletionSuccessful
In this example, the activity deletes the IAM user "JohnDoe" and removes all attached entities, such as access keys, policies, login profiles, group memberships, and MFA devices. The result of the operation (success or failure) is stored in the Boolean variable "isDeletionSuccessful" for further handling in the workflow.